类 FoxitPDFSDKPython3.HeaderFooterContentGenerator 继承关系图:

Public 成员函数
def	HeaderFooterContentGenerator ()
	Constructor.

def	HeaderFooterContentGenerator (other)
	Constructor, with another header-footer content generator object. 更多...

def	AddDate (format_type)
	Add a format string for a specified date format type. 更多...

def	AddPageNumber (format_type)
	Add a format string for a specified page number format type. 更多...

def	AddString (new_string)
	Add a string. 更多...

def	Clear ()
	Clear strings (including format strings) which have been added to current content generator. 更多...

def	GenerateContent ()
	Generate a final string which can be used as header-footer content. 更多...

def	IsEmpty ()
	Check whether current object is empty or not. 更多...

静态 Public 属性
	e_DateFormatDDDotMMDotYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDDDotMMDotYY
	如果使用此项，"dd.mm.yy" 将被用作日期格式字符串。

	e_DateFormatDDDotMMDotYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDDDotMMDotYYYY
	如果使用此项，"dd.mm.yyyy" 将被用作日期格式字符串。

	e_DateFormatDDotMDotYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDDotMDotYYYY
	如果使用此项，"d.m.yyyy" 将被用作日期格式字符串。

	e_DateFormatDDSlashMMSlashYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDDSlashMMSlashYY
	如果使用此项，"dd/mm/yy" 将被用作日期格式字符串。

	e_DateFormatDDSlashMMSlashYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDDSlashMMSlashYYYY
	如果使用此项，"dd/mm/yyyy" 将被用作日期格式字符串。

	e_DateFormatDSlashMSlashYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDSlashMSlashYY
	如果使用此项，"d/m/yy" 将被用作日期格式字符串。

	e_DateFormatDSlashMSlashYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatDSlashMSlashYYYY
	如果使用此项，"d/m/yyyy" 将被用作日期格式字符串。

	e_DateFormatMDotDDotYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMDotDDotYY
	如果使用此项，"m.d.yy" 将被用作日期格式字符串。

	e_DateFormatMDotDDotYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMDotDDotYYYY
	如果使用此项，"m.d.yyyy" 将被用作日期格式字符串。

	e_DateFormatMMDotDDDotYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMDotDDDotYY
	如果使用此项，"mm.dd.yy" 将被用作日期格式字符串。

	e_DateFormatMMDotDDDotYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMDotDDDotYYYY
	如果使用此项，"mm.dd.yyyy" 将被用作日期格式字符串。

	e_DateFormatMMDotYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMDotYY
	如果使用此项，"mm.yy" 将被用作日期格式字符串。

	e_DateFormatMMSlashDDSlashYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMSlashDDSlashYY
	如果使用此项，"mm/dd/yy" 将被用作日期格式字符串。

	e_DateFormatMMSlashDDSlashYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMSlashDDSlashYYYY
	如果使用此项，"mm/dd/yyyy" 将被用作日期格式字符串。

	e_DateFormatMMSlashYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMSlashYY
	如果使用此项，"mm/yy" 将被用作日期格式字符串。

	e_DateFormatMMSlashYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMMSlashYYYY
	如果使用此项，"mm/yyyy" 将被用作日期格式字符串。

	e_DateFormatMSlashD = _fsdk.HeaderFooterContentGenerator_e_DateFormatMSlashD
	如果使用此项，"m/d" 将被用作日期格式字符串。

	e_DateFormatMSlashDSlashYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMSlashDSlashYY
	如果使用此项，"m/d/yy" 将被用作日期格式字符串。

	e_DateFormatMSlashDSlashYYYY = _fsdk.HeaderFooterContentGenerator_e_DateFormatMSlashDSlashYYYY
	如果使用此项，"m/d/yyyy" 将被用作日期格式字符串。

	e_DateFormatYYHyphenMMHyphenDD = _fsdk.HeaderFooterContentGenerator_e_DateFormatYYHyphenMMHyphenDD
	如果使用此项，"yy-mm-dd" 将被用作日期格式字符串。

	e_DateFormatYYYYHyphenMMHyphenDD = _fsdk.HeaderFooterContentGenerator_e_DateFormatYYYYHyphenMMHyphenDD
	如果使用此项，"yyyy-mm-dd" 将被用作日期格式字符串。

	e_PageNumberFormatDefault = _fsdk.HeaderFooterContentGenerator_e_PageNumberFormatDefault
	如果使用此项，"1" 将被用作页码格式字符串。

	e_PageNumberFormatNumberOfCount = _fsdk.HeaderFooterContentGenerator_e_PageNumberFormatNumberOfCount
	如果使用此项，"1 of n" 将被用作页码格式字符串。

	e_PageNumberFormatNumberSlashCount = _fsdk.HeaderFooterContentGenerator_e_PageNumberFormatNumberSlashCount
	如果使用此项，"1/n" 将被用作页码格式字符串。

	e_PageNumberFormatPageNumber = _fsdk.HeaderFooterContentGenerator_e_PageNumberFormatPageNumber
	如果使用此项，"Page 1" 将被用作页码格式字符串。

	e_PageNumberFormatPageNumberOfCount = _fsdk.HeaderFooterContentGenerator_e_PageNumberFormatPageNumberOfCount
	如果使用此项，"Page 1 of n" 将被用作页码格式字符串。

详细描述

This class is the generator for header-footer content. It can help user to combine dates in specified format, page numbers in specified format and any customized text content to one string which can be used as header-footer content.

构造及析构函数说明

◆ HeaderFooterContentGenerator()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.HeaderFooterContentGenerator ( other )

Constructor, with another header-footer content generator object.

参数

[in] other Another header-footer content generator object.

成员函数说明

◆ AddDate()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.AddDate ( format_type )

Add a format string for a specified date format type.

Header-footer content can contain format string for date. The date format string will be replaced by actual date time in specified format when the header-footer is used in PDF document.

参数

[in] format_type Date format type. Please refer to values starting from FoxitPDFSDKPython3.HeaderFooterContentGenerator.e_DateFormatMSlashD and this should be one of these values.

返回: None.

◆ AddPageNumber()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.AddPageNumber ( format_type )

Add a format string for a specified page number format type.

Header-footer content can contain format string for page number. The page number format string will be replaced by page number in specified format when the header-footer is used in PDF document.

参数

[in] format_type Page number format type. Please refer to values starting from FoxitPDFSDKPython3.HeaderFooterContentGenerator.e_PageNumberFormatDefault and this should be one of these values.

返回: None.

◆ AddString()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.AddString ( new_string )

Add a string.

参数

[in] new_string A string.

返回: None.

◆ Clear()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.Clear ( )

Clear strings (including format strings) which have been added to current content generator.

After this function is called, current content generator will be the same as a newly constructed object.

返回: None.

◆ GenerateContent()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.GenerateContent ( )

Generate a final string which can be used as header-footer content.

返回: The final string which can be used as header-footer content.

◆ IsEmpty()

def FoxitPDFSDKPython3.HeaderFooterContentGenerator.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

返回: true means current object is empty, while false means not.

Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ HeaderFooterContentGenerator()

成员函数说明

◆ AddDate()

◆ AddPageNumber()

◆ AddString()

◆ Clear()

◆ GenerateContent()

◆ IsEmpty()